Skip to content

Move server metrics to health port #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 30, 2025
Merged

Move server metrics to health port #751

merged 1 commit into from
Jun 30, 2025
+2 −0

Conversation

aldudko
Copy link
Contributor

@aldudko aldudko commented Jun 12, 2025

Similarly to the agent, run /metrics endpoint on the health port instead of the admin port.

By default, adminServer binds to localhost, which doesn't let prometheus to scrap server's /metrics.
If I bind adminServer to podIP, /debug/ endpoints will be exposed too since they are served by the same adminServer.
It is more secure to keep /debug on localhost and expose metrics on podIP:healthPort

https://kubernetes.slack.com/archives/CPS4Z8G8N/p1749655050637769

How was this tested?

./bin/proxy-server --server-ca-cert=certs/frontend/issued/ca.crt --server-cert=certs/frontend/issued/proxy-frontend.crt --server-key=certs/frontend/private/proxy-frontend.key --cluster-ca-cert=certs/agent/issued/ca.crt --cluster-cert=certs/agent/issued/proxy-frontend.crt --cluster-key=certs/agent/private/proxy-frontend.key --health-port=8134 --admin-port=8133

curl localhost:8133/metrics
<a href="//localhost:8134/metrics">Moved Permanently</a>.

curl localhost:8134/metrics
# HELP go_gc_duration_seconds A summary of the wall-time pause (stop-the-world) duration in garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 0.000157916
go_gc_duration_seconds{quantile="0.25"} 0.000157916
...

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jun 12, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: aldudko / name: Alex Dudko (487279d)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jun 12, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @aldudko!

It looks like this is your first PR to kubernetes-sigs/apiserver-network-proxy 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/apiserver-network-proxy has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot requested review from elmiko and ipochi June 12, 2025 02:46
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 12, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @aldudko. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 12, 2025
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 12, 2025
@cheftako
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 12, 2025
@cheftako
Copy link
Contributor

@ipochi I'm fine with the change. I think the only real concern would be backward compatibility. Arguably with admin port bound to localhost then it seems unlikely that anyone if relying on scraping from the port. Are you ok as is or do you think which should ask for a backward compatibility mode flag?

jkh52
jkh52 reviewed Jun 14, 2025
View reviewed changes
@aldudko
Move server metrics to health port
487279d 
Signed-off-by: Alex Dudko <alex.dudko@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 23, 2025
@jkh52
Copy link
Contributor

jkh52 commented Jun 24, 2025

/lgtm

@ipochi would you approve?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 24, 2025
@jkh52 jkh52 assigned ipochi and unassigned jkh52 Jun 24, 2025
@jkh52
Copy link
Contributor

jkh52 commented Jun 30, 2025

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aldudko, jkh52

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 30, 2025
@k8s-ci-robot k8s-ci-robot merged commit ea89bf0 into kubernetes-sigs:master Jun 30, 2025
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cheftako cheftako cheftako left review comments

@jkh52 jkh52 jkh52 left review comments

@elmiko elmiko Awaiting requested review from elmiko

@ipochi ipochi Awaiting requested review from ipochi

Assignees

@ipochi ipochi

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@aldudko @k8s-ci-robot @cheftako @jkh52 @ipochi